enum {
    pixPurge = 1,
    noNewDevice = 2,
    useTempMem = 4,
    keepLocal = 8,
    useDistantHdwrMem = 16,
    useLocalHdwrMem = 32,
    pixelsPurgeable = 64,
    pixelsLocked = 128,
    kAllocDirectDrawSurface = 16384,
    mapPix = 65536,
    newDepth = 131072,
    alignPix = 262144,
    newRowBytes = 524288,
    reallocPix = 1048576,
    clipPix = 268435456,
    stretchPix = 536870912,
    ditherPix = 1073741824,
    gwFlagErr = -2147483648
};

Constant descriptions

pixPurge

If you specify this flag for the flags parameter of the NewGWorld function, NewGWorld makes the base address for the offscreen pixel image purgeable.

noNewDevice

If you specify this flag for the flags parameter of the NewGWorld function, NewGWorld does not create a new offscreen GDevice structure; instead, NewGWorld uses either the GDevice structure you specify or the GDevice structure for a video card on the user’s system.

useTempMem

If you specify this in the flags parameter of the NewGWorld function, NewGWorld creates the base address for an offscreen pixel image in temporary memory. You generally should not use this flag. You should use temporary memory only for fleeting purposes and only with the AllowPurgePixels function so that other applications can launch.

keepLocal

If you specify this in the flags parameter of the NewGWorld function, NewGWorld creates a pixel image in Macintosh main memory where it cannot be cached to a graphics accelerator card.

If you specify this in the flags parameter of UpdateGWorld, UpdateGWorld keeps the offscreen pixel image in Macintosh main memory.

useDistantHdwrMem

useLocalHdwrMem

pixelsPurgeable

If you specify this in the state parameter of the SetPixelsState function, SetPixelsState makes the base address for an offscreen pixel map purgeable. If you use the SetPixelsState function without passing it this flag, then SetPixelsState makes the base address for an offscreen pixel map unpurgeable. If the GetPixelsState function returns this flag, then the base address for an offscreen pixel is purgeable.

pixelsLocked

If you specify this flag for the state parameter of the SetPixelsState function, SetPixelsState locks the base address for an offscreen pixel image. If you use the SetPixelsState function without passing it this flag, then SetPixelsState unlocks the offscreen pixel image. If the GetPixelsState function returns this flag, then the base address for an offscreen pixel is locked.

kAllocDirectDrawSurface

mapPix

If the UpdateGWorld function returns this flag, then it remapped the colors in the offscreen pixel map to a new color table.

newDepth

If the UpdateGWorld function returns this flag, then it translated the offscreen pixel map to a different pixel depth.

alignPix

If the UpdateGWorld function returns this flag, then it realigned the offscreen pixel image to an onscreen window.

newRowBytes

If the UpdateGWorld function returns this flag, then it changed the rowBytes field of the PixMap structure for the offscreen graphics world.

reallocPix

If the UpdateGWorld function returns this flag, then it reallocated the base address for the offscreen pixel image. Your application should then reconstruct the pixel image or draw directly in a window instead of preparing the image in an offscreen graphics world.

clipPix

If you specify this flag in the flags parameter of the UpdateGWorld function, then UpdateGWorld updates and clips the pixel image to the new boundary rectangle specified. If the UpdateGWorld function returns this flag, then it clipped the pixel image.

stretchPix

If you specify this flag in the flags parameter of the UpdateGWorld function, then UpdateGWorld updates and stretches or shrinks the pixel image to the new boundary rectangle specified. If the UpdateGWorld function returns this flag, then it stretched or shrank the offscreen image.

ditherPix

If you specify this flag in the flags parameter of the UpdateGWorld function, then UpdateGWorld dithers the pixel image to the new boundary rectangle specified. Include this flag with the clipPix or stretchPix flag. If the UpdateGWorld function returns this flag, then it dithered the offscreen image.

gwFlagErr

If the UpdateGWorld function returns this flag, then it was unsuccessful and the offscreen graphics world was left unchanged.

© 2000 Apple Computer, Inc. — (Last Updated 4/14/2000)